Skip to content

documentation: add doc for SMDDP collectives #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 41 commits into
base: smddp-coll
Choose a base branch
from

Conversation

mchoi8739
Copy link
Collaborator

@mchoi8739 mchoi8739 commented Dec 12, 2022

Issue #, if available:

Description of changes:

documentation for SMDDP collectives + small fix for compiler_config (wrong indentation)

Testing done:

local sphinx build completed

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

NivekNey and others added 30 commits December 2, 2022 12:48
Co-authored-by: Basil Beirouti <[email protected]>
Co-authored-by: Kalyani Nikure <[email protected]>
* Add DXB region

* Remove change from neuron

* Adding DXB to TF 2.1.0 and 2.1.1
Co-authored-by: Brock Wade <[email protected]>
Co-authored-by: Mufaddal Rohawala <[email protected]>
hballuru and others added 10 commits December 9, 2022 14:36
* Set to true by default
* Update pt ddp supported versions

Add validation for instance type, fw and py versions.

Clean up logs and comments

Add integ test for ACCL disabled

Fix integ test params

Fix formatting errors in tests

Update logic to set accl_enabled to none for default on cases
@mchoi8739 mchoi8739 force-pushed the smddp-collectives-doc branch from 1a48cb5 to cfddea6 Compare December 12, 2022 21:21
@mchoi8739 mchoi8739 force-pushed the smddp-collectives-doc branch from cfddea6 to 83d754e Compare December 12, 2022 21:28
Comment on lines +342 to +344
"communication_options": { # Optional. This is set to auto by default.
"backend": "auto"
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make these lines bold?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately Sphinx code block doesn't support adding styles

Copy link
Collaborator Author

@mchoi8739 mchoi8739 Dec 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the code block every character is recognizes as straight code syntax, so it would show the element for bold style, instead of the bold style applied to the lines.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +199 to +201
"communication_options": {
"backend": "auto", # backend is set to auto by default
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

@vishwakaria vishwakaria self-requested a review December 12, 2022 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.